Interface UserTraffic

All Superinterfaces:
IPCObject
All Known Implementing Classes:
UserTrafficImpl

public interface UserTraffic extends IPCObject
Information provided by the PKI file:

    \class UserTraffic
    
    \brief UserTraffic represents the user traffic information (PDU).
    
    \example appWindow().getActiveFile().getMainSimulation().getFrameInstanceAt(0).getTrafficSource()
    
Author:
Auto-generated
  • Method Details

    • getTrafficColorCode

      int getTrafficColorCode()
      Information provided by the PKI file:
      
          \brief Returns the color code of this PDU.
          
          \return int, the color code of this PDU.
          
              
      Returns:
      int Returns a int
    • getTrafficTypeString

      String getTrafficTypeString()
      Information provided by the PKI file:
      
          \brief Returns the traffic type of this PDU.
          
          \return QString, the traffic type of this PDU.
          
              
      Returns:
      String Returns a String
    • getSourceDevice

      Device getSourceDevice()
      Information provided by the PKI file:
      
          \brief Returns the source device of this PDU.
          
          \return Device, the Device object of the source device of this PDU.
          
              
      Returns:
      Device Returns a Device
    • getDestinationDevice

      Device getDestinationDevice()
      Information provided by the PKI file:
      
          \brief Returns the destination device of this PDU.
          
          \return Device, the Device object of the destination device of this PDU.
          
              
      Returns:
      Device Returns a Device
    • getPdu

      Pdu getPdu()
      Information provided by the PKI file:
      
          \brief Returns the PDU object of this PDU.
          
          \return PDU, the PDU object of this PDU.
          
              
      Returns:
      Pdu Returns a Pdu
    • getSendPort

      Port getSendPort()
      Information provided by the PKI file:
      
          \brief Returns the sending port of this PDU.
          
          \return Port, the Port object of the sending port of this PDU.
          
              
      Returns:
      Port Returns a Port
    • getCanonicalSource

      String getCanonicalSource()
      Information provided by the PKI file:
      
          \brief Returns the name of the source of this PDU.
          
          \return QString, the name of the source of this PDU.
          
              
      Returns:
      String Returns a String
    • getCanonicalDestination

      String getCanonicalDestination()
      Information provided by the PKI file:
      
          \brief Returns the name of the destination of this PDU.
          
          \return QString, the name of the destination of this PDU.
          
              
      Returns:
      String Returns a String
    • getStatus

      TrafficStatus getStatus()
      Information provided by the PKI file:
      
          \brief Returns the status of this PDU.
          
          \return TrafficStatus,      the status of this PDU.
          Traffic statuses:   eTrafficNotSend = 0,
          eTrafficInProgress = 1,
          eTrafficFailed = 2,
          eTrafficSuccessful = 3
          
              
      Returns:
      TrafficStatus Returns a TrafficStatus
    • getTestCondition

      TrafficStatus getTestCondition()
      Information provided by the PKI file:
      
          \brief Returns the connectivity test status of this PDU.
          
          \return TrafficStatus,      the the test condition status of this PDU.
          Traffic statuses:   eTrafficNotSend = 0,
          eTrafficInProgress = 1,
          eTrafficFailed = 2,
          eTrafficSuccessful = 3
          
              
      Returns:
      TrafficStatus Returns a TrafficStatus
    • getPoints

      int getPoints()
      Information provided by the PKI file:
      
          \brief Returns the point value of this PDU.
          
          \return int, the point value of this PDU.
          
              
      Returns:
      int Returns a int
    • getPduSize

      int getPduSize()
      Information provided by the PKI file:
      
          \brief Returns the size of this PDU.
          
          \return int, the size of this PDU.
          
              
      Returns:
      int Returns a int